Developer Documentation

QuickTime 4 API Documentation

3D Graphics Programming with QuickDraw 3D 1.5.4

Previous | QD3D Book | Overview | Chapter Contents | Next |

Creating and Accessing FSSpec Storage Objects

QuickDraw 3D provides routines for creating and managing Macintosh storage objects specified using a file system specification structure.

Q3FSSpecStorage_New

You can use the Q3FSSpecStorage_New function to create a new memory storage object specified using a file system specification structure.

TQ3StorageObject Q3FSSpecStorage_New (const FSSpec *fs);
fs
A file system specification structure specifying the name and location of a Macintosh file.

DESCRIPTION

The Q3FSSpecStorage_New function returns, as its function result, a new storage object associated with the Macintosh file specified by the fs parameter. The specified file is assumed to be closed. QuickDraw 3D opens the file, and, when the associated storage object is closed or disposed of, QuickDraw 3D closes the file. If Q3FSSpecStorage_New cannot create a new storage object, it returns the value NULL .

ERRORS

kQ3ErrorOutOfMemory kQ3ErrorNULLParameter

Q3FSSpecStorage_Get

You can use the Q3FSSpecStorage_Get function to get information about an FSSpec storage object.

TQ3Status Q3FSSpecStorage_Get (
                     TQ3StorageObject storage,
                     FSSpec *fs);
storage
A Macintosh FSSpec storage object.
fs
On entry, a pointer to a file system specification structure. On exit, a pointer to the file system specification structure associated with the specified Macintosh FSSpec storage object.

DESCRIPTION

The Q3FSSpecStorage_Get function returns, through the fs parameter, the file system specification structure associated with the Macintosh FSSpec storage object specified by the storage parameter.

Q3FSSpecStorage_Set

You can use the Q3FSSpecStorage_Set function to set information about an FSSpec storage object.

TQ3Status Q3FSSpecStorage_Set (
                     TQ3StorageObject storage,
                     const FSSpec *fs);
storage
A Macintosh FSSpec storage object.
fs
A file system specification structure specifying the name and location of a Macintosh file.

DESCRIPTION

The Q3FSSpecStorage_Set function sets the file system specification structure of the file associated with the Macintosh FSSpec storage object specified by the storage parameter to the structure specified by the fs parameter.

SPECIAL CONSIDERATIONS

You must not use Q3FSSpecStorage_Set with an open Macintosh FSSpec storage object.

ERRORS

kQ3ErrorStorageIsOpen


© 1997 Apple Computer, Inc.

Previous | QD3D Book | Overview | Chapter Contents | Next |